Skip to content

Commit d2d54d3

Browse files
committed
Update comments
1 parent a3453be commit d2d54d3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ APIs for managing module identities, module twins, and querying modules
5454
public class Modules
5555
{
5656
/// <summary>
57-
/// Create a module.
57+
/// Create a device module.
5858
/// </summary>
5959
/// <param name="moduleIdentity">The module to create.</param>
6060
/// <param name="cancellationToken">The cancellation token.</param>
6161
/// <returns></returns>
62-
public virtual async Task<Response<ModuleIdentity>> CreateIdentityAsync(ModuleIdentity moduleIdentity, CancellationToken cancellationToken);
62+
public virtual async Task<Response<ModuleIdentity>> CreateIdentityAsync(ModuleIdentity moduleIdentity, CancellationToken cancellationToken = default);
6363

6464
/// <summary>
65-
/// Get a single device.
65+
/// Get a single device module.
6666
/// </summary>
6767
/// <param name="deviceId">The unique identifier of the device that contains the module.</param>
6868
/// <param name="moduleId">The unique identifier of the module to get.</param>
@@ -79,7 +79,7 @@ public class Modules
7979
public virtual async AsyncPageable<ModuleIdentity> GetIdentitiesAsync(string deviceId, CancellationToken cancellationToken = default);
8080

8181
/// <summary>
82-
/// Update a module.
82+
/// Update a device module.
8383
/// </summary>
8484
/// <param name="moduleIdentity">The module to update.</param>
8585
/// <param name="ifMatch">A string representing a weak ETag for this module, as per RFC7232. The update operation is performed
@@ -90,7 +90,7 @@ public class Modules
9090
public virtual async Task<Response<ModuleIdentity>> UpdateIdentityAsync(ModuleIdentity moduleIdentity, string ifMatch = null, CancellationToken cancellationToken = default);
9191

9292
/// <summary>
93-
/// Delete a single module.
93+
/// Delete a single device module.
9494
/// </summary>
9595
/// <param name="deviceId">The unique identifier of the device that contains the module.</param>
9696
/// <param name="moduleId">The unique identifier of the module to get.</param>
@@ -108,7 +108,7 @@ public class Modules
108108
/// <param name="moduleId">The unique identifier of the device module.</param>
109109
/// <param name="cancellationToken">The cancellation token.</param>
110110
/// <returns>The retrieved module twin.</returns>
111-
public virtual async Task<Response<TwinData>> GetTwinAsync(string deviceId, string moduleId, CancellationToken cancellationToken);
111+
public virtual async Task<Response<TwinData>> GetTwinAsync(string deviceId, string moduleId, CancellationToken cancellationToken = default);
112112

113113
/// <summary>
114114
/// List a set of module twins.

0 commit comments

Comments
 (0)