From 5e59860c4670e8f2973a843691427d08e89e45a7 Mon Sep 17 00:00:00 2001
From: timtay-microsoft <timtay@microsoft.com>
Date: Tue, 28 Apr 2020 13:49:27 -0700
Subject: [PATCH] Add Iot Hub API categories to design doc (#11649)

---
 .../Azure.Iot.Hub.Service/src/API Design.md   | 84 ++++++++++++++++---
 1 file changed, 73 insertions(+), 11 deletions(-)

diff --git a/sdk/iot/Azure.Iot.Hub.Service/src/API Design.md b/sdk/iot/Azure.Iot.Hub.Service/src/API Design.md
index 8c0e4dbc332b..0893928c1ed6 100644
--- a/sdk/iot/Azure.Iot.Hub.Service/src/API Design.md	
+++ b/sdk/iot/Azure.Iot.Hub.Service/src/API Design.md	
@@ -1,24 +1,86 @@
-
+# Azure Iot Hub Service API Design Doc
+This document outlines the APIs for the Azure Iot Hub Service SDK
 
+<details><summary><b>Constructors</b></summary>
+    
+```csharp
 
+```
+</details>
 
-# Azure Iot Hub Service API Design Doc
-This document outlines the APIs for the Azure Iot Hub Service SDK
+<details><summary><b>Configurations</b></summary>
+APIs for managing configurations for devices and modules
+```csharp
 
-## Azure.Core usage
-Within this SDK, we will make use of several Azure.Core library classes
+```
+</details>
 
-[AsyncPageable\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/AsyncPageable.cs): An enumerable set of items that are retrieved asynchronously over multiple http requests
+<details><summary><b>Statistics</b></summary>
+APIs for getting statistics about devices and modules, as well as service statistics
+```csharp
 
-[Pageable\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Pageable.cs): An enumerable set of items that are retrieved synchronously over multiple http requests
+```
+</details>
 
-[Page\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Page.cs): A single page within a Pageable. Should not be exposed to the user, since we strive to abstract out the pagination
+<details><summary><b>Registry</b></summary>
+APIs for managing device and module identities
+```csharp
 
-[Response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Response.cs): Contains the raw HTTP response details
+```
+</details>
+
+<details><summary><b>Jobs</b></summary>
+APIs for using IotHub jobs
+```csharp
+
+```
+</details>
+
+<details><summary><b>V2 Jobs</b></summary>
+(maybe combine with job APIs, or maybe don't expose v1 job APIs. Talk with service about this)
+
+```csharp
+
+```
+</details>
 
-[Response\<T>](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/src/Response%7BT%7D.cs): Contains a Response instance and a parsed type derived from that HTTP response (for instance, Response\<ModelData> when retrieving models)
-<details><summary><b>Sample</b></summary>
+<details><summary><b>Twin</b></summary>
+Device and module twin operations
+```csharp
+
+```
+</details>
+
+<details><summary><b>Methods</b></summary>
+Device and module direct methods
+```csharp
+
+```
+</details>
+
+<details><summary><b>Cloud to Device Messaging</b></summary>
+No sign of this in the swagger    
+```csharp
+
+```
+</details>
+
+<details><summary><b>Feedback Message</b></summary>
+APIs for getting feedback messages
+```csharp
+
+```
+</details>
+
+<details><summary><b>File Upload Notifications</b></summary>
+No sign of this in the swagger
+```csharp
+
+```
+</details>
 
+<details><summary><b>Query</b></summary>
+APIs for querying on device or module identities
 ```csharp
 
 ```