Skip to content

Commit

Permalink
Add Iot Hub API categories to design doc (#11649)
Browse files Browse the repository at this point in the history
  • Loading branch information
timtay-microsoft authored Apr 28, 2020
1 parent 0d236d9 commit 5e59860
Showing 1 changed file with 73 additions and 11 deletions.
84 changes: 73 additions & 11 deletions sdk/iot/Azure.Iot.Hub.Service/src/API Design.md
Original file line number Diff line number Diff line change
@@ -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

```
Expand Down

0 comments on commit 5e59860

Please sign in to comment.