Skip to content

Commit 30bcebe

Browse files
authored
swagger(iothub): Adding overrides for type names (#12026)
1 parent a2a74c1 commit 30bcebe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2842
-2699
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
11
# Azure Iot Hub Service API Design Doc
22
This document outlines the APIs for the Azure Iot Hub Service SDK
33

4+
<details><summary><b>Type definition names</b></summary>
5+
6+
```
7+
Configuration - TwinConfiguration
8+
Module - ModuleIdentity
9+
Device - DeviceIdentity
10+
Twin - TwinData
11+
Interface - PnpInterface
12+
Property - PnpProperty
13+
Reported - PnpReported
14+
Desired - PnpDesired
15+
```
16+
</details>
17+
418
<details><summary><b>Constructors</b></summary>
519

620
```csharp
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// Device identity.
10+
/// </summary>
11+
[CodeGenModel("Device")]
12+
public partial class DeviceIdentity
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// Module identity.
10+
/// </summary>
11+
[CodeGenModel("Module")]
12+
public partial class ModuleIdentity
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// The desired property of a digital twin.
10+
/// </summary>
11+
[CodeGenModel("Desired")]
12+
internal partial class PnpDesired
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// The digital twin interface which defines all the properties.
10+
/// </summary>
11+
[CodeGenModel("Interface")]
12+
internal partial class PnpInterface
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// The property of a digital twin. This consists of both the Desired and Reported property.
10+
/// </summary>
11+
[CodeGenModel("Property")]
12+
internal partial class PnpProperty
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// The reported property of a digital twin.
10+
/// </summary>
11+
[CodeGenModel("Reported")]
12+
internal partial class PnpReported
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// Configuration for automatic device and module management.
10+
/// </summary>
11+
[CodeGenModel("Configuration")]
12+
public partial class TwinConfiguration
13+
{
14+
}
15+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using Azure.Core;
5+
6+
namespace Azure.Iot.Hub.Service.Models
7+
{
8+
/// <summary>
9+
/// Twin data.
10+
/// </summary>
11+
[CodeGenModel("Twin")]
12+
public partial class TwinData
13+
{
14+
}
15+
}
Lines changed: 139 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)