Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Iot Hub API categories to design doc #11649

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A note here, stating that these relate to IoT Hub identity registry operation, would give some additional context.

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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note - Device and module twin operations

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